﻿shantay                package: nenhum                R Documentation


Sorteio de unidades amostrais com base em criterios fornecidos pelo
usuario e na distancia minima necessaria entre elas.


Description:

A partir de um dataframe, sorteia um determinado numero de unidades
amostrais com base nos criterios sexo, ano de nascimento maximo, area
de estudo e distancia minima entre suas localizacoes. Salva essas
informacoes em um arquivo .txt separado por tabulacao e retorna um plano 
cartesiano com as unidades amostrais sorteadas.


Usage:

shantay(dados, n.amostra, ano.nasc, sexo, area.estudo, dist.min)


Arguments:

dados:		Dataframe; deve conter na primeira coluna o ID da unidade 
		amostral; na segunda coluna, o sexo; na terceira coluna, 
		o ano de nascimento da unidade amostral (para critério de
		idade);	na quarta coluna, a área de estudo na qual a pessoa
		reside; na quinta coluna, o ID da localizacao da unidade
		amostral, na sexta e sétima colunas, a latitude e a longitude
		da localizacao de cada unidade amostral, respectivamente.

n.amostra:	Valor numerico; numero de unidades amostrais a serem 
		sorteadas.

ano.nasc:	Valor numerico; ano de nascimento maximo de interesse (para
		criterio de idade minima). Se idade das unidades amostrais 
		estiver em anos, pode-se calcular seu ano de nascimento 
		subtraindo-se a idade em anos de cada unidade amostral do 
		ano calendario em que a informacao foi obtida.

sexo:		Caracter; sexo das unidades amostrais de interesse. Recebe:
		'f' (feminino), 'm' (masculino) ou 'NA' se o sexo nao importar
		como criterio de selecao.

area.estudo:	Caracter; recebe o nome da area de estudo de interesse.

dist.min:	Valor numerico; distancia (em metros) minima a que cada
		unidade amostral deve estar uma da outra.


Details:

E necessario ter o pacote 'sp' instalado.

A latitude e a longitude devem estar informadas em graus decimais e, no
dataframe de input, localizadas nas sexta e setima colunas, respectivamente.

Todos os argumentos da funcao devem ser fornecidos.


Value:

A funcao shantay retorna:
	
	No console, o numero de unidades amostrais que foram removidos
	a cada criterio de selecao fornecido e um dataframe contendo
	as unidades amostrais selecionadas com suas respectivas
	características (sexo, ano de nascimento, área de estudo,
	localizacao, latitude e longitude de cada unidade amostral).

	Tambem retorna um arquivo .txt separado por tabulacao deste dataframe,
	salvo no diretorio de trabalho corrente do R sob o nome 'amostragem.txt'.

	Um plano cartesinado em que estao plotados os pontos referentes as 
	unidades amostrais selecionadas.Para melhor visualizacao, recomenda-se
	abrir uma nova janela grafica antes de executar a funcao. Para Windows,
	x11(), por exemplo.


Warnings:

A funcao e interrompida e retornam-se mensagens de erro quando o objeto de
entrada nao e um dataframe, quando algum dos argumentos nao e fornecido, o
pacote 'sp' nao esta instalado e quando o numero de unidades amostrais
disponiveis para sorteio apos os criterios de selecao e menor do que o numero
de unidades amostrais a serem sorteadas. 

Na primeira vez que a funcao e executada, exibe uma mensagem de aviso que o
pacote 'sp' foi carregado SE ele estiver instalado.


Notes:

Atencao para nao sobrescrever o arquivo .txt. Se ele for interessante, convem-se
renomea-lo antes de executar a funcao novamente. 


Author(s):

Lucas Teixeira
lteixeira@ib.usp.br

Sao Paulo, 16 de maio de 2016


References:

Newing, H., Eagle, C., Puri, R. & Watson, C.W. 2011. Conducting research in 
conservation: a social science perspective, Routledge, New York.

Pacote 'sp': https://cran.r-project.org/web/packages/sp/sp.pdf


See Also:

Funcoes: subset(), spDists(), sample(), plot()


Acknowledgments:

A Gabriela Marin e Vinicius Biffi,
pela disponibilidade em me explicar alguns comandos e argumentos.


Examples:

#Exemplo 1:

#criando vetores para incluir no dataframe
pessoa <- c("a1", "a2", "b1", "b2", "b3", "c1", "c2", "d1", "d2", "e1")
sexo <- c("m", "f", "f", "m", "f", "m", "f", "f", "m", "m")
nascimento <- c(1973, 1977, 1980, 1979, 2000, 1950, 1949, 1995, 1994, 1965)
area_estudo <- c(rep("area2", 2), rep("area1", 8))
casa <- c("a", "a", "b", "b", "b", "c", "c", "d", "d", "e")
lat<- c(-22.92956, -22.92956, -22.93443, -22.93443, -22.93443, -22.93002, 
	-22.93002, -22.95848, -22.95848, -22.93266)
long <- c(-46.30385, -46.30385, -46.30895, -46.30895, -46.30895, -46.30291, 
	-46.30291, -46.30754, -46.30754, -46.28227)

#criando dataframe para exemplo
exemplo <- data.frame(pessoa, sexo, nascimento, area_estudo, casa, lat, long, 
		      stringsAsFactors=FALSE)

#abrindo uma nova janela grafica para melhor visualizacao do plano cartesiano
x11()

shantay(exemplo, 3, 1997, sexo="f", "area1", 500)
shantay(exemplo, 4, 1997, sexo="NA", "area1", 500)


#Exemplo 2:
#necessario ter salvo o arquivo 'dados_exemplo_help.txt' no diretorio de trabalho

#lendo planilha de dados para exemplo
dados <- read.table("dados_exemplo_help.txt", header=TRUE, dec=".", sep="\t",
	 as.is = TRUE)

shantay(dados, 8, 1997, sexo="f", "area1", 800)
shantay(dados, 10, 1995, sexo="NA", "area1", 500)